Class SelfTest

java.lang.Object
com.netscape.cms.selftests.SelfTest
Direct Known Subclasses:
SystemCertsVerification

public abstract class SelfTest extends Object
This class implements an individual self test.
Author:
mharmsen, thomask
  • Field Details

  • Constructor Details

    • SelfTest

      public SelfTest()
  • Method Details

    • getCMSEngine

      public CMSEngine getCMSEngine()
    • setCMSEngine

      public void setCMSEngine(CMSEngine engine)
    • initSelfTest

      public void initSelfTest(SelfTestSubsystem subsystem, String instanceName, ConfigStore parameters) throws EDuplicateSelfTestException, EInvalidSelfTestException, EMissingSelfTestException
      Initializes this subsystem with the configuration store associated with this instance name.
      Parameters:
      subsystem - the associated subsystem
      instanceName - the name of this self test instance
      parameters - configuration store (self test parameters)
      Throws:
      EDuplicateSelfTestException - subsystem has duplicate name/value
      EInvalidSelfTestException - subsystem has invalid name/value
      EMissingSelfTestException - subsystem has missing name/value
    • startupSelfTest

      public abstract void startupSelfTest() throws ESelfTestException
      Notifies this subsystem if it is in execution mode.
      Throws:
      ESelfTestException - failed to start
    • shutdownSelfTest

      public abstract void shutdownSelfTest()
      Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization.
    • getSelfTestName

      public String getSelfTestName()
      Returns the name associated with this self test. This method may return null if the self test has not been initialized.
      Returns:
      instanceName of this self test
    • getSelfTestConfigStore

      public ConfigStore getSelfTestConfigStore()
      Returns the root configuration storage (self test parameters) associated with this subsystem.
      Returns:
      configuration store (self test parameters) of this subsystem
    • getSelfTestDescription

      public abstract String getSelfTestDescription(Locale locale)
      Retrieves description associated with an individual self test. This method may return null.
      Parameters:
      locale - locale of the client that requests the description
      Returns:
      description of self test
    • runSelfTest

      public abstract void runSelfTest(LogEventListener logger) throws Exception
      Execute an individual self test.
      Parameters:
      logger - specifies logging subsystem
      Throws:
      Exception - self test exception